VIVE 3DSP Native C Library  ver 1.0.0.0
Audio 3DSP (3D Sound Perception) Native C Library
occlusion.h
Go to the documentation of this file.
1 //========= Copyright 2016-2018, HTC Corporation. All rights reserved. ===========
2 #pragma once
3 #include "audio_engine.h"
4 #include "audio_source.h"
5 
6 #ifdef __cplusplus
7 extern "C" {
8 #endif
9  namespace HTC_Vive3DSP_SDK {
10  /*****************************************************************************************************************/
11  /* Occlusion properties */
12  /*****************************************************************************************************************/
13 
19  typedef struct vive_3dsp_internal_occlusion_object vive_3dsp_occlusion;
20 
26  {
31  float rhf;
33  float lfratio;
36  float density;
37  float radius;
40  };
41 
52  vive_3dsp_occlusion_create_object(vive_3dsp_context *api);
63  vive_3dsp_occlusion_destroy_object(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion);
75  vive_3dsp_occlusion_enable(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, bool enable);
88  vive_3dsp_occlusion_set_material(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_OCC_MATERIAL material);
102  vive_3dsp_occlusion_set_cover_ratio(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, vive_3dsp_audiosource *src, float cover_ratio);
117  vive_3dsp_occlusion_set_channel_cover_ratio(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, vive_3dsp_audiosource *src, VIVE_3DSP_OCCLUSION_CHANNEL_ID chnID, float cover_ratio);
128  vive_3dsp_occlusion_set_channel_num(vive_3dsp_context *api, int chnNum);
138  vive_3dsp_occlusion_set_depth_ratio(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, float depthRatio);
149  vive_3dsp_occlusion_set_material_RHF(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, float rhf);
161  vive_3dsp_occlusion_set_material_LF_ratio(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, float LF_ratio);
171  vive_3dsp_occlusion_set_mode(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_OCCLUSION_ENGINE mode);
181  vive_3dsp_occlusion_set_radius(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, float radius);
191  vive_3dsp_occlusion_set_box_size(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_Vector3 size);
201  vive_3dsp_occlusion_set_position(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_Vector3 position);
211  vive_3dsp_occlusion_set_rotation(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_Quaternion rotation);
221  vive_3dsp_occlusion_set_property(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, VIVE_3DSP_OCCLUSION_PROPERTY prop);
222 
225  vive_3dsp_occlusion_set_material_HS_params(vive_3dsp_context *api, vive_3dsp_occlusion *occlusion, float gain, float freq, float Q);
227  }
228 #ifdef __cplusplus
229 }
230 #endif
float density
Definition: occlusion.h:36
float rhf
Definition: occlusion.h:31
int VIVE_3DSP_OCCLUSION_CHANNEL_ID
Definition: audio_engine.h:39
Definition: audio_engine.h:158
Definition: audio_engine.h:144
The vive_3dsp_audiosource structure represents the 3D audio source model.
float lfratio
Definition: occlusion.h:33
VIVE_3DSP_API_STATUS
Definition: audio_engine.h:25
#define VIVE_3DSP_API_DLLEXPORT
Definition: audio_engine.h:6
VIVE_3DSP_OCC_MATERIAL material
Definition: occlusion.h:30
VIVE_3DSP_OCC_MATERIAL
Definition: audio_engine.h:102
The vive_3dsp_occlusion structure represents the 3D occlusion model.
VIVE_3DSP_OCCLUSION_COMPUTE_ENGINE
Definition: audio_engine.h:132
VIVE_3DSP_Vector3 position
Definition: occlusion.h:27
VIVE_3DSP_Vector3 size
Definition: occlusion.h:28
The vive_3dsp_context structure represents the overall audio engine of 3D sound model.
Definition: vive_3dsp_api.h:15
VIVE_3DSP_OCCLUSION_ENGINE
Definition: audio_engine.h:123
VIVE_3DSP_OCCLUSION_ENGINE mode
Definition: occlusion.h:38
VIVE_3DSP_OCCLUSION_COMPUTE_ENGINE computeMode
Definition: occlusion.h:39
float radius
Definition: occlusion.h:37
VIVE_3DSP_Quaternion rotation
Definition: occlusion.h:29